Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: updated link for migrate_docker2containerd.md #11729

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

kundan2707
Copy link
Contributor

What type of PR is this?

/kind bug
/kind documentation

What this PR does / why we need it: Link correction

Which issue(s) this PR fixes: 11727

Fixes #11727

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

NONE

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/bug Categorizes issue or PR as related to a bug. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Nov 19, 2024
@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Nov 19, 2024
@VannTen
Copy link
Contributor

VannTen commented Nov 19, 2024

/ok-to-test
/approve
/lgtm

@k8s-ci-robot k8s-ci-robot added the ok-to-test Indicates a non-member PR verified by an org member that is safe to test. label Nov 19, 2024
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 19, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: kundan2707, VannTen

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 19, 2024
@VannTen
Copy link
Contributor

VannTen commented Nov 19, 2024 via email

@VannTen
Copy link
Contributor

VannTen commented Nov 19, 2024 via email

@VannTen
Copy link
Contributor

VannTen commented Nov 19, 2024 via email

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 20, 2024
@k8s-ci-robot
Copy link
Contributor

New changes are detected. LGTM label has been removed.

@kundan2707
Copy link
Contributor Author

/retest

@tico88612
Copy link
Member

/retitle Docs: updated link for migrate_docker2containerd.md

@k8s-ci-robot k8s-ci-robot changed the title updated link for migrate_docker2containerd.m Docs: updated link for migrate_docker2containerd.md Nov 20, 2024
Comment on lines +92 to +105
* [Cgroups](/docs/operations/cgroups.md)
* [Encrypting-secret-data-at-rest](/docs/operations/encrypting-secret-data-at-rest.md)
* [Etcd](/docs/operations/etcd.md)
* [Ha-mode](/docs/operations/ha-mode.md)
* [Hardening](/docs/operations/hardening.md)
* [Integration](/docs/operations/integration.md)
* [Large-deployments](/docs/operations/large-deployments.md)
* [Mirror](/docs/operations/mirror.md)
* [Nodes](/docs/operations/nodes.md)
* [Offline-environment](/docs/operations/offline-environment.md)
* [Port-requirements](/docs/operations/port-requirements.md)
* [Recover-control-plane](/docs/operations/recover-control-plane.md)
* [Upgrades](/docs/operations/upgrades.md)
Copy link
Member

@tico88612 tico88612 Nov 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* [Cgroups](/docs/operations/cgroups.md)
* [Encrypting-secret-data-at-rest](/docs/operations/encrypting-secret-data-at-rest.md)
* [Etcd](/docs/operations/etcd.md)
* [Ha-mode](/docs/operations/ha-mode.md)
* [Hardening](/docs/operations/hardening.md)
* [Integration](/docs/operations/integration.md)
* [Large-deployments](/docs/operations/large-deployments.md)
* [Mirror](/docs/operations/mirror.md)
* [Nodes](/docs/operations/nodes.md)
* [Offline-environment](/docs/operations/offline-environment.md)
* [Port-requirements](/docs/operations/port-requirements.md)
* [Recover-control-plane](/docs/operations/recover-control-plane.md)
* [Upgrades](/docs/operations/upgrades.md)

I don't recommend you modify it directly; pre-commit will check, and if it's not consistent, it won't pass.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tico88612 I will revert changes.

VannTen and others added 7 commits November 27, 2024 22:31
This only really help with the easiest part of building your inventory
(listing the hosts) as you still need to edit your groups vars and
similar.
The opaqueness of the script does not really help our users to
understand their own inventory.

Furthermore, there is not really a reason that something which is common
to all the Ansible ecosystem should be done in a special way for
Kubespray.
contrib/dind use inventory_builder, which is removed. It overlaps with
the function of kind (Kubernetes in Docker) and has not see change
(apart from linting driven ones) for a long time.

It also does not seem to work (provisioning playbook crash).
There is no need to repeat the full example here, simply state what
variables are.
- The bastion is not needed for a simple example
- All is implicit we can just define our host in groups directly
Our README is currently pretty cluttered:
- Part of the README duplicates docs/getting_started/getting-started.md
-> Remove duplicates and extract useful info into the getting-started.md

- General info on Ansible environment troubleshooting
-> remove most of it as it's not specific to Kubespray, move to
docs/ansible/ansible.md
-> split inventory-related stuff of ansible.md into it's own file. This
should host documentation on how to manages Kubespray inventories in the
future.

ansible.md:
- remove the list of "Unused" variables, as:
  1. It's not accurate
  2. What matters is where users should put their variables
@k8s-ci-robot k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Nov 27, 2024
@tico88612
Copy link
Member

@kundan2707 Your PR shouldn't contain commit records from other PRs. You should only have one commit. (only a0bc499 record)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/bug Categorizes issue or PR as related to a bug. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-none Denotes a PR that doesn't merit a release note. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

link is broken in upgrade doc, section migrate-from-docker-to-containerd
4 participants